<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one or more</a>
<span class="sourceLineNo">003</span><a id="line.3"> * contributor license agreements.  See the NOTICE file distributed with</a>
<span class="sourceLineNo">004</span><a id="line.4"> * this work for additional information regarding copyright ownership.</a>
<span class="sourceLineNo">005</span><a id="line.5"> * The ASF licenses this file to You under the Apache License, Version 2.0</a>
<span class="sourceLineNo">006</span><a id="line.6"> * (the "License"); you may not use this file except in compliance with</a>
<span class="sourceLineNo">007</span><a id="line.7"> * the License.  You may obtain a copy of the License at</a>
<span class="sourceLineNo">008</span><a id="line.8"> *</a>
<span class="sourceLineNo">009</span><a id="line.9"> *      http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">010</span><a id="line.10"> *</a>
<span class="sourceLineNo">011</span><a id="line.11"> * Unless required by applicable law or agreed to in writing, software</a>
<span class="sourceLineNo">012</span><a id="line.12"> * distributed under the License is distributed on an "AS IS" BASIS,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a>
<span class="sourceLineNo">014</span><a id="line.14"> * See the License for the specific language governing permissions and</a>
<span class="sourceLineNo">015</span><a id="line.15"> * limitations under the License.</a>
<span class="sourceLineNo">016</span><a id="line.16"> */</a>
<span class="sourceLineNo">017</span><a id="line.17">package org.apache.commons.dbutils;</a>
<span class="sourceLineNo">018</span><a id="line.18"></a>
<span class="sourceLineNo">019</span><a id="line.19">import java.sql.ResultSet;</a>
<span class="sourceLineNo">020</span><a id="line.20">import java.sql.SQLException;</a>
<span class="sourceLineNo">021</span><a id="line.21"></a>
<span class="sourceLineNo">022</span><a id="line.22">/**</a>
<span class="sourceLineNo">023</span><a id="line.23"> * Interface to define how implementations can interact with column handling when constructing a bean from a</a>
<span class="sourceLineNo">024</span><a id="line.24"> * {@link java.sql.ResultSet}.  ColumnHandlers do the work of retrieving data correctly from the {@code ResultSet}.</a>
<span class="sourceLineNo">025</span><a id="line.25"> */</a>
<span class="sourceLineNo">026</span><a id="line.26">public interface ColumnHandler {</a>
<span class="sourceLineNo">027</span><a id="line.27">    /**</a>
<span class="sourceLineNo">028</span><a id="line.28">     * Test whether this {@code ColumnHandler} wants to handle a column targeted for a value type matching</a>
<span class="sourceLineNo">029</span><a id="line.29">     * {@code propType}.</a>
<span class="sourceLineNo">030</span><a id="line.30">     *</a>
<span class="sourceLineNo">031</span><a id="line.31">     * @param propType The type of the target parameter.</a>
<span class="sourceLineNo">032</span><a id="line.32">     * @return true is this property handler can/wants to handle this value; false otherwise.</a>
<span class="sourceLineNo">033</span><a id="line.33">     */</a>
<span class="sourceLineNo">034</span><a id="line.34">    boolean match(Class&lt;?&gt; propType);</a>
<span class="sourceLineNo">035</span><a id="line.35"></a>
<span class="sourceLineNo">036</span><a id="line.36">    /**</a>
<span class="sourceLineNo">037</span><a id="line.37">     * Do the work required to retrieve and store a column from {@code ResultSet} into something of type</a>
<span class="sourceLineNo">038</span><a id="line.38">     * {@code propType}. This method is called only if this handler responded {@code true} after a call to</a>
<span class="sourceLineNo">039</span><a id="line.39">     * {@link #match(Class)}.</a>
<span class="sourceLineNo">040</span><a id="line.40">     *</a>
<span class="sourceLineNo">041</span><a id="line.41">     * @param rs The result set to get data from. This should be moved to the correct row already.</a>
<span class="sourceLineNo">042</span><a id="line.42">     * @param columnIndex The position of the column to retrieve.</a>
<span class="sourceLineNo">043</span><a id="line.43">     * @return The converted value or the original value if something doesn't work out.</a>
<span class="sourceLineNo">044</span><a id="line.44">     * @throws SQLException if the columnIndex is not valid; if a database access error occurs or this method is</a>
<span class="sourceLineNo">045</span><a id="line.45">     *                called on a closed result set</a>
<span class="sourceLineNo">046</span><a id="line.46">     */</a>
<span class="sourceLineNo">047</span><a id="line.47">    Object apply(ResultSet rs, int columnIndex) throws SQLException;</a>
<span class="sourceLineNo">048</span><a id="line.48">}</a>




























































</pre>
</div>
</main>
</body>
</html>
